Skip to main content

DocumentMetadata How To's

How to's for the DocumentMetadata guide.

How to Use DocumentMetadata?​

How to Use DocumentMetadata?​

The following steps should be followed to add and configure the DocumentMetadata object on a form.

Add the Object to the Form​

  1. Open the form design screen
  2. Navigate to the Toolbox panel
  3. Locate the DocumentMetadata object
  4. Drag and drop the object onto the form

Select the Information to Display​

  1. Click the object
  2. The Properties panel opens on the right side
  3. Select the metadata information you want to display

Example metadata fields:

  • Form Creation Date
  • Form Number (FormId)

Build and Publish the Project​

  1. Go to the Run section from the menu
  2. Build and publish the project successfully

Verify in the Web Interface​

  1. Log in to the web interface using your username and password
  2. Open the relevant form from the menu
  3. Observe that the selected metadata information is automatically populated on the object

Usage Scenarios​

  • Displaying the form’s creation date to the user
  • Showing a unique form number for each form
  • Making system information visible in audit and tracking processes

Tips & Recommendations​

  • DocumentMetadata is generally used in areas like a Label or Header
  • Ideal for fields that should not be editable by the user
  • Highly recommended for process and reporting forms

Notes​

  • The object works as read-only
  • It does not allow user interaction
  • Values are loaded as soon as the form is opened

What Is DocumentMetadata?​

What Is DocumentMetadata?​

DocumentMetadata is a form object used to display a form’s system-level metadata (meta information) to the user.

With this object, the developer can display:

  • The form’s creation date
  • The form’s unique form number (FormId)
  • Other document information generated by the system

automatically on the form, without requiring any manual user input.

Primary Purpose​

The primary purpose of DocumentMetadata is to:

  • Display informative, non-editable system data to the user
  • Ensure the accuracy of technical information related to the form
  • Prevent errors caused by manual data entry

Where Is It Used?​

  • Application forms
  • Process forms
  • Audit and reporting screens
  • Official documents
  • Archive and tracking forms

Key Features​

  • Automatically populates data when the form is opened
  • Cannot be modified by the user
  • Displays system metadata directly
  • Fully aligned with the form lifecycle

Notes​

  • The displayed information is reliable since it is generated by the system.
  • The same values are preserved before and after the form is saved.
  • The object is for display purposes only; no data entry is performed.

How to Use Client Enabled?​

What is Client Enabled?​

Client Enabled is a property that defines whether a form control is active (enabled) on the client side when the form is first loaded.
If it is set to True, the control is immediately usable by the user.
If it is set to False, the control is disabled and cannot be interacted with until a specific condition or rule activates it.

This property is especially useful for controlling the user’s interaction flow and applying dynamic behaviors using the Rule Manager.

What Does It Do?​

The property allows developers to:

  • Control when a form control becomes interactive.
  • Prevent users from entering or changing data until prerequisites are met.
  • Dynamically enable or disable controls based on user input or logic.

Example Scenario — Conditional Activation​

Scenario:
A form contains a checkbox called “I Accept Terms” and a text field called “Signature.”
The goal is to make the “Signature” field inactive until the user checks “I Accept Terms.”

Steps to Implement:​

  1. Select the “Signature” field in the form editor.

  2. In the Properties panel, find the Client Enabled field.

  3. Set the value to False — the field will now be disabled by default when the form loads.

  4. Open the Rule Manager.

  5. Add a new rule:

    Condition:

Action:

  1. Save and publish the form.

Result:​

  • When the form loads, the “Signature” field is disabled.
  • Once the user checks “I Accept Terms,” the field automatically becomes active and editable.

Behavior Summary​

Property StateDescription
TrueThe control is active and ready for user interaction when the form loads.
FalseThe control is disabled at load time and can be enabled dynamically via rules or code.

Notes & Best Practices​

  • Use the Client Enabled property to manage client-side interactivity without requiring server actions.
  • Combine it with Rule Manager to define when and how controls become active.
  • Remember: if server enablement is disabled, the client cannot enable the control even if Client Enabled is set to True.
  • By default, this property is set to True (active).

Summary​

Client Enabled improves form usability by letting developers control when and how users interact with form controls.
It is essential for creating responsive, condition-based form experiences where user actions dynamically change the form’s state.